/*-
 * KeywordMatch.java
 *
 * $LastChangedBy: stein $
 * $LastChangedRevision: 95 $
 * $LastChangedDate: 2007-02-13 16:19:24 +0000 (Tue, 13 Feb 2007) $
 * $HeadURL: svn://localhost/SMS/src/com/googlecode/attention/sms/comp/KeywordMatch.java $
 * 
 * Copyright (c) 2007, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention.sms.comp;

/**
 * Keyword Match bit stream.
 *
 * @author Stein Gunnar Bakkeby
 */
public class KeywordMatch {
  /* Field values */
  private int[]   bitstream;
  private int     index;
  private boolean matchFound;
  
  /**
   * Constructor, creates a default keyword match indicating that
   * no match has been found.
   */
  public KeywordMatch() {
    bitstream  = new int[0];
    matchFound = false;;
    index      = 0;
  }

  /**
   * This will return true if a keyword match has been found.
   * 
   * @return True if match has been found, false otherwise
   */
  public boolean isMatchFound() {
    return matchFound;
  }

  /**
   * Set this to true if a match has been found, false otherwise.
   * 
   * @param found Boolean value
   */
  public void setMatchFound(final boolean found) {
    this.matchFound = found;
  }

  
  /**
   * This will return the current index of the original data.
   * 
   * @return The offset into the original data
   */
  public int getCurrentIndex() {
    return index;
  }
  
  /**
   * This will set the current index.
   * 
   * @param index The offest into the original data
   */
  public void setCurrentIndex(final int index) {
    this.index = index;
  }

  /**
   * This will return the bitstream.
   * 
   * @return The keyword match bitstream
   */
  public int[] getBitstream() {
    return bitstream;
  }

  /**
   * This will set the keyword match bitstream.
   * 
   * @param bitstream The bitstream
   */
  public void setBitstream(final int[] bitstream) {
    this.bitstream = bitstream;
  }

}